4.4.7.2 授权应用-基于名称

可通过此接口在用户目录为角色授权应用及应用分类。

  • 基本信息

    请求地址：https://SDPC-IP:4433/api/v3/role/assignResourceByName

    请求方式：POST

  • 请求体（Body）
参数 中文名称 必须 类型 描述
directoryDomain 用户目录唯一标识 是 string 用户目录唯一标识，在控制台点击用户目录设置即可查看。
本地用户目录的唯一标识为 local。
外部用户目录示例：custom01339（唯一标识无需携带@）
name 角色名 是 string 示例：role1
resource 应用列表 否 object
├─ op 操作方式 否 string 操作类型。
取值范围：
append-追加更新（默认）
reset-重置
delete-删除
├─ key 应用唯一标识 否 string key 是指标识应用的对象，即通过什么方式（或值）来授权指定的应用。零信任提供了两种标识来定义应用，即 id/name。
存在 resource 参数时，此参数必传。
取值范围：
id-应用id
name-应用名称
├─ data 否 object / object[] 存在 resource 参数时，此参数必传。
├─├─ data 应用唯一标识对应数据 否 string data 是 key 值的结果，即若 key 的赋值是 name，那么 data 对应的赋值就是应用名，如: "mail"。若 key 的赋值是 id，那么 data 就需要写应用的 id 值。
存在 resource 参数时，此参数必传。
key 与 data 的对应取值示例如下：
id：1345c177-e4f6-11ee-835b-fefcfeefe529
name：mail
├─├─ effectiveTime 授权生效时间 否 string 支持毫秒级别的Unix时间戳，以及时间字符串格式如：2024-03-18 12:00:00。
不传时默认立刻生效。
示例：
时间戳：1710745688563
时间字符串：2024-03-18 12:00:00、2024/03/18 12:00:00
├─├─ expireTime 授权过期时间 否 string 支持毫秒级别的Unix时间戳，以及时间字符串格式如：2024-03-18 12:00:00。
不传时默认永不过期。
示例：
时间戳：1710745688563
时间字符串：2024-03-18 12:00:00、2024/03/18 12:00:00
resourceGroup 应用分类列表 否 object
├─ op 操作方式 否 string 操作类型。
取值范围：
append-追加更新（默认）
reset-重置
delete-删除
├─ key 应用分类唯一标识 否 string key 是指标识应用分类的对象，即通过什么方式（或值）来授权指定的应用分类。零信任提供了两种标识来定义应用分类，即 id/name。
存在 resourceGroup 参数时，此参数必传。
取值范围：
id-应用分类 id
name-应用分类名称
├─ data 否 object / object[] 存在 resourceGroup 参数时，此参数必传。
├─├─ data 应用分类唯一标识对应数据 否 string data 是 key 值的结果，即若 key 的赋值是 name，那么 data 对应的赋值就是应用分类名，如: "mail"。若 key 的赋值是 id，那么 data 就需要写应用分类的 id 值。
存在 resourceGroup 参数时，此参数必传。
key 与 data 的对应取值示例如下：
id：1345c177-e4f6-11ee-835b-fefcfeefe529
name：默认分类
├─├─ effectiveTime 授权生效时间 否 string 支持毫秒级别的Unix时间戳，以及时间字符串格式如：2024-03-18 12:00:00。
不传时默认立刻生效。
示例：
时间戳：1710745688563
时间字符串：2024-03-18 12:00:00、2024/03/18 12:00:00
├─├─ expireTime 授权过期时间 否 string 支持毫秒级别的Unix时间戳，以及时间字符串格式如：2024-03-18 12:00:00。
不传时默认永不过期。
示例：
时间戳：1710745688563
时间字符串：2024-03-18 12:00:00、2024/03/18 12:00:00
  • 请求示例
curl --location --request POST 'https://SDPC-IP:4433/api/v3/role/assignResourceByName?lang=zh-CN' \
--header 'Content-Type: application/json' \
--header 'X-Ca-Key: {{X-Ca-Key}}' \
--header 'X-Ca-Nonce: {{X-Ca-Nonce}}' \
--header 'X-Ca-TimeStamp: {{X-Ca-TimeStamp}}' \
--header 'X-Ca-Sign: {{X-Ca-Sign}}' \
--data-raw '{
    "directoryDomain": "local",
    "name": "role1",
    "resource": {
        "op": "append",
        "key": "name",
        "data": [
            {
                "data": "mail",
                "effectiveTime": "1710745688563",
                "expireTime": "1720745688563"
            }, {
                "data": "erp",
                "effectiveTime": "1710745688563",
                "expireTime": "1720745688563"
            }
        ]
    },
    "resourceGroup": {
        "op": "append",
        "key": "name",
        "data": [
            {
                "data": "category3",
                "effectiveTime": "2024-03-18 12:00:00",
                "expireTime": "2024-04-18 12:00:00"
            }
        ]
    }
}'
  • 返回数据
参数 中文名称 类型 描述
code 响应码 string OK 表示成功，其他表示出错。具体含义请参考错误码定义
data 响应数据 object
msg 描述信息 string
traceId 调用链id string  
  • 响应示例
{
    "code": "OK",
    "data": {},
    "msg": "请求成功",
    "traceId": "00ca7db2adde821f"
}
深信服科技 all right reserved，powered by Gitbook本文档更新于： 2024-11-20 11:03

results matching ""

    No results matching ""